Package com.cisco.pt.ipc.sim.impl
Class DHCPPoolImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.DHCPPoolImpl
Information provided by the PKI file:
\class DhcpPool
\brief DhcpPool holds and manipulates the DHCP pool on the DHCP server.
\example network().getDevice("Router0").getProcess("DhcpServer").getPoolAt(0)
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionDHCPPoolImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getEndIp()Information provided by the PKI file:getLeaseAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:voidsetDefaultRouter(IPAddress ipAddress) Information provided by the PKI file:voidsetDnsServerIp(IPAddress ipAddress) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetMaxUsers(int max) Information provided by the PKI file:voidsetNetworkAddress(IPAddress ipAddress) voidsetNetworkMask(IPAddress network, IPAddress mask) Information provided by the PKI file:voidsetNextAvailableIpAddress(IPAddress ipAddress) voidsetStartIp(IPAddress ipAddress) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
DHCPPoolImpl
public DHCPPoolImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getDhcpPoolName
Information provided by the PKI file:
\brief Returns the name of this pool. \return string, the name of this pool.- Specified by:
getDhcpPoolNamein interfaceDHCPPool- Returns:
- String Returns a String
-
getNetworkAddress
Information provided by the PKI file:
\brief Returns the network address of this pool. \return ip, the network address of this pool.- Specified by:
getNetworkAddressin interfaceDHCPPool- Returns:
- IPAddress Returns a IPAddress
-
setNetworkMask
Information provided by the PKI file:
\brief Sets the network address for this pool. \param network, the network address for this pool. \param mask, the subnet mask for this pool.- Specified by:
setNetworkMaskin interfaceDHCPPool- Parameters:
network- Takes in a parameter of networkmask- Takes in a parameter of mask
-
getSubnetMask
Information provided by the PKI file:
\brief Returns the subnet mask of this pool \return ip, the subnet mask of this pool.- Specified by:
getSubnetMaskin interfaceDHCPPool- Returns:
- IPAddress Returns a IPAddress
-
setDefaultRouter
Information provided by the PKI file:
\brief Sets the default router address. \param ipAddress, the IP address of the default router.- Specified by:
setDefaultRouterin interfaceDHCPPool- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
getDefaultRouter
Information provided by the PKI file:
\brief Returns the default router IP address. \return ip, the default router IP address.- Specified by:
getDefaultRouterin interfaceDHCPPool- Returns:
- IPAddress Returns a IPAddress
-
getLeaseAt
Information provided by the PKI file:
\brief Returns the DHCP lease at the specified index. \param index, the index of the DHCP lease of interest. \return DhcpPoolLease, the DhcpPoolLease object at the specified index.- Specified by:
getLeaseAtin interfaceDHCPPool- Parameters:
index- Takes in a parameter of index- Returns:
- DHCPPoolLease Returns a DHCPPoolLease
-
setStartIp
Information provided by the PKI file:
\brief Sets the start IP address for this pool. \param ipAddress, the start IP address for this pool.- Specified by:
setStartIpin interfaceDHCPPool- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
setNextAvailableIpAddress
- Specified by:
setNextAvailableIpAddressin interfaceDHCPPool- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
setEndIp
Information provided by the PKI file:
\brief Sets the end IP address for this pool. \param ipAddress, the end IP address for this pool. -
setNetworkAddress
- Specified by:
setNetworkAddressin interfaceDHCPPool- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
getStartIp
Information provided by the PKI file:
\brief Returns the start IP address of this pool. \return ip, the start IP address of this pool.- Specified by:
getStartIpin interfaceDHCPPool- Returns:
- IPAddress Returns a IPAddress
-
getEndIp
Information provided by the PKI file:
\brief Returns the end IP address of this pool. \return ip, the end IP address of this pool. -
setDnsServerIp
Information provided by the PKI file:
\brief Sets the DNS server IP address. \param ipAddress, the DNS server IP address.- Specified by:
setDnsServerIpin interfaceDHCPPool- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
getDnsServerIp
Information provided by the PKI file:
\brief Returns the DNS server IP address. \return ip, the DNS server IP address.- Specified by:
getDnsServerIpin interfaceDHCPPool- Returns:
- IPAddress Returns a IPAddress
-
getDomainName
Information provided by the PKI file:
\brief Returns the domain name. \return string, the domain name.- Specified by:
getDomainNamein interfaceDHCPPool- Returns:
- String Returns a String
-
getMaxUsers
public int getMaxUsers()Information provided by the PKI file:
\brief Returns the maximum number of users. \return int, the maximum number of users.- Specified by:
getMaxUsersin interfaceDHCPPool- Returns:
- int Returns a int
-
setMaxUsers
public void setMaxUsers(int max) Information provided by the PKI file:
\brief Set max users \param max, the maximum number of users.- Specified by:
setMaxUsersin interfaceDHCPPool- Parameters:
max- Takes in a parameter of max
-
getTftpAddress
Information provided by the PKI file:
\brief Returns the IP address of the TFTP server. \return ip, the IP address of the TFTP server.- Specified by:
getTftpAddressin interfaceDHCPPool- Returns:
- IPAddress Returns a IPAddress
-
getWlcAddress
- Specified by:
getWlcAddressin interfaceDHCPPool- Returns:
- IPAddress Returns a IPAddress
-